home *** CD-ROM | disk | FTP | other *** search
/ Amiga Tools 5 / Amiga Tools 5.iso / tools / net-tools / amitrack / amitrack.readme < prev    next >
Encoding:
Text File  |  1996-07-16  |  8.5 KB  |  239 lines
  1. Short: AmiTCP on-line Amiga tracking system
  2. Type: comm/net
  3. Author: jfriesne@ucsd.edu (Jeremy Friesner)
  4. Uploader: jfriesne@ucsd.edu (Jeremy Friesner)
  5. Requires: Workbench 2.04+, AmiTCP3.0b+
  6. Replaces: comm/tcp/AmiTrack1.0
  7. Version: 1.1
  8.  
  9. ----------------------------------------------------------------
  10.         
  11.             AMITRACK V1.1
  12.                      
  13.                       (Released 6/28/96)
  14.                      
  15. ----------------------------------------------------------------
  16.  
  17.  
  18. INTRODUCTION
  19. ------------
  20. What is AmiTrack?  Hmm, good question.
  21.  
  22. I was talking to an AmiPhone user a few weeks ago, and
  23. he was lamenting that it was hard to find another AmiPhone
  24. user who was online to talk to.  We decided what was needed
  25. was a way to find out who else is available, sort of an
  26. "Active Amiga registry".
  27.  
  28. So that's what AmiTrack does.  AmiTrack is an AmiTCP program
  29. that acts as the keeper of a list of Amigas that are currently
  30. on-line.  It isn't limited to just AmiPhone users, either; you
  31. can register your Amiga to advertise any message string you want.
  32.  
  33. This archive contains two executables: AmiTrack and AmiTrackServer.
  34. AmiTrack is a client that you can use to notify the world of your
  35. Amiga's presence on the internet, and AmiTrackServer is useful if
  36. you wish to let people use your Amiga as a registry site.  Both
  37. utilities must be launched from the CLI.
  38.  
  39.  
  40. INSTALLATION
  41. ------------
  42. There isn't any, really.  Just copy the files to wherever you
  43. want to keep them.
  44.  
  45.  
  46. AMITRACK 
  47. --------
  48. The AmiTrack program is designed to connect to an Amiga running
  49. the AmiTrackServer program.  While connected, it periodically
  50. does two things:  it sends "ping" packets to the AmiTrackServer
  51. to let it know that you're still there, and it downloads the
  52. list of currently registered Amigas on that server, for your
  53. viewing pleasure.  When you quit AmiTrack, you will be removed
  54. from the server's list of Amigas.
  55.  
  56. AmiTrack understands the following command line arguments:
  57.  
  58. #1: The Internet host name of the Amiga that is running AmiTrackServer,
  59.     that you wish to register with.  
  60.     
  61. #2: The comment string you wish to have associated with your Amiga.
  62.     Make sure to put this string in "quotes" if there are any spaces
  63.     in it.  This defaults to no comment.
  64.     
  65. #3: The port number on the server which you wish to connect to.
  66.     This defaults to port 18945 (which by some bizarre coincidence,
  67.     is also the default port for AmiTrackServer to accept connections
  68.     on)
  69.     
  70. So, a valid AmiTrack command could be:
  71.  
  72. AmiTrack
  73.  
  74. or,
  75.  
  76. AmiTrack isys.ml.org "This is my comment" 5217
  77.  
  78. or anything in between.
  79.  
  80.  
  81. AMITRACK GUI
  82. ------------
  83. AmiTrack's GUI is fairly straightforward.  It consists of several
  84. string gadgets, two buttons, and a ListView.  The Server, Port, and
  85. Comment string gadgets are self-explanatory (I hope!).  The ListView
  86. shows the IP addresses and comment strings of everyone logged in
  87. to the server you are connected to.  This list may be updated by
  88. clicking on the "Refresh" button, and will also be updated automatically
  89. every few minutes, as indicated by the associated string gadget.
  90. The "Ping" button causes your client to send a packet to the 
  91. AmiTrackServer, in effect saying "I'm here!".  If the AmiTrackServer
  92. does not hear from your client for about five minutes straight, it
  93. will assume that you are no longer available and remove you from
  94. its list.  Hence, it is probably a bad idea AmiTrack's ping interval
  95. to more than five minutes.
  96.  
  97. Automatic refreshes and pings can be disabled by setting their
  98. interval gadget to zero.
  99.  
  100. AmiTrack can be iconified via the Project menu.  Double clicking
  101. on its icon will bring back its GUI.  It will continue to ping
  102. the AmiTrackServer while it is iconified.
  103.  
  104.  
  105. AMITRACKSERVER
  106. --------------
  107. The AmiTrackServer executable is designed to accept AmiTrack
  108. client connections from all over the Internet and dole out
  109. information about who else has connected to it recently.  Most
  110. people won't need this program, but it's there anyway for those
  111. who would like to run their own server.  AmiTrackServer has no
  112. GUI, rather it sends only output to the CLI.  It will display
  113. its list of registered Amigas to the CLI at regular intervals,
  114. and whenever the list is modified.  The list displays the IP
  115. name of each Amiga, its comment string, and the number of seconds
  116. that have elapsed since the last "ping" was heard from that
  117. Amiga.
  118.  
  119. AmiTrackServer takes one optional command line argument, the
  120. port number upon which it is to accept connections.  This number
  121. defaults to 18945.
  122.  
  123. AmiTrackServer will quit if sent a CTRL-C signal, and will
  124. refresh its CLI output of its list if send a CTRL-D.
  125.  
  126.  
  127. TECHNICAL
  128. ---------
  129. AmiTrack tries to be as reliable and efficient as possible.
  130. The AmiTrack server keeps a linked list of the currently
  131. registered Amiga hostnames and their comment strings, as
  132. well as a timestamp of last time those Amigas were heard from.
  133. If an AmiTrack client has not sent a packet to the server
  134. for a specified amount of time (currently five minutes),
  135. it is liable to be removed from the registered list.  This
  136. way, even if the client crashed and didn't send a disconnect
  137. packet, its entry won't hang around forever.  To retrieve
  138. the list of clients, AmiTrack opens a TCP connection to
  139. the AmiTrack server, which immediately spits out a list of
  140. IP numbers, names, and comment strings, and then closes the
  141. connection.
  142.  
  143. AmiTrack is written in DICE C, but there shouldn't be anything
  144. too compiler-dependant in it.
  145.  
  146.  
  147. MANIFEST
  148. --------
  149. The following files should be in the AmiTrack archive:
  150.  
  151. ********************
  152.  
  153.  
  154. AUTHOR
  155. ------
  156. This program was written by Jeremy Friesner, using DICE C.
  157. My email address is jfriesne@ucsd.edu.
  158.  
  159.  
  160. ACKNOWLEDGEMENTS
  161. ----------------
  162. Thanks to Oliver Hotz for providing a full-time AmiTrack server site.
  163. Thanks to AndyS and Gallant on #amiga for helping me debug & test.
  164.  
  165.  
  166. DISTRIBUTION
  167. ------------
  168. AmiTrack is fully in the public domain.  Do whatever you want with it.
  169.  
  170.  
  171. BUGS
  172. ----
  173. - Comments with leading spaces can mess up the client's field alignment.
  174.   
  175. - Sometimes after you exit the server, it can't be run again
  176.   for a minute or so afterwards (it will error out, saying the
  177.   TCP port is in use).  This usually happens if GetTrackList has
  178.   been run on this server recently.  I think this is a "feature" 
  179.   of BSD-based TCP software, though, as I've seen the same 
  180.   thing happen on UNIX machines running other software.
  181.  
  182. - There ought to be a mechanism to ensure that you can't set the
  183.   ping interval to be greater than the server's timeout interval.
  184.   
  185.  
  186. TODO
  187. ----
  188. - Make a UNIX version of the server, and perhaps the client
  189.   as well.
  190.   
  191. - Add a way to automatically launch your favorite net program
  192.   with a given hostname from the list as an argument.
  193.   
  194. - Add a "NO GUI" option for completely invisible background use.
  195.  
  196. - Make AmiTrack runnable from the Workbench.
  197.  
  198.  
  199. OTHER STUFF
  200. -----------
  201. Some other programs I wrote:  (try them, they're cool! ;))
  202.  
  203. GadMget - Loads in an Aminet RECENT or INDEX file and lets you choose
  204.           files to download via a pair of ListViews.  Features keyword
  205.           searching and sorting by name, size, age, directory, and 
  206.           description.  When you're done, it outputs the ftp commands
  207.           that are needed to download the selected files.  The output
  208.           formatting is extremely flexible, allowing generation of 
  209.           many formats:  ftp, ncftp, ftp-by-mail, shell scripts, etc.
  210.           Comes with an ARexx script to completely automate downloading 
  211.           with ncFTP.  (util/misc/GadMget2.05.lha,93K)
  212.   
  213. AmiSlate - A paint program that works with AmiTCP to allow two people
  214.            to cooperatively paint on the same drawing from different
  215.            computers.  Features an extensive ARexx port which allows
  216.            the construction of new features and games.  Comes with
  217.            ARexx scripts for chess, tic-tac-toe, backgammon, and others.
  218.            (comm/tcp/AmiSlate1.4.lha,115K)
  219.  
  220. AmiPhone - An Internet voice-chat program, similar to IPhone and
  221.        VoiceChat and Nevot and all that, only Amiga-specific.
  222.        Features aflexible buffering mechanism for slow connections,
  223.        an ARexx port, IFF 8SVX transmission and playback, internal
  224.        multitasking, and support for a variety of digitizers.
  225.        (comm/net/AmiPhone1.91.lha,142K)
  226.  
  227.  
  228. HISTORY
  229. -------
  230. 1.1 : (Public Release 6/28/96)
  231.     - Separated the AmiTrack server and client into two separate
  232.       programs, and integrated GetTrackList into the client.
  233.     - Added a nice GUI to the client program.
  234.     - The AmiTrack protocol has changed slightly--v1.1 is not quite
  235.       compatible with v1.0.  Sorry!  :(
  236.       
  237. 1.0 : (Public Release 6/7/96)
  238.     - Initial release.  Works well for me, but untested in "real life".
  239.